Operation WorkflowInstance.Cancel (Cancel workflow)

In component org.nuxeo.ecm.platform.routing.operations

Description

Cancel the workflow with the given id, where the required id is the id of the document representing the workflow instance.

Operation id	WorkflowInstance.Cancel
Aliases	`Context.CancelWorkflow`
Category	Workflow Context
Label	Cancel workflow
Requires	Workflow
Since

Parameters

Name	Description	Type	Required	Default value
id		string	yes

Signature

Inputs	void
Outputs	void

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.platform.routing.core.api.operation.CancelWorkflowOperation
Contributing Component	org.nuxeo.ecm.platform.routing.operations

JSON Definition

{
  "id" : "WorkflowInstance.Cancel",
  "aliases" : [ "Context.CancelWorkflow" ],
  "label" : "Cancel workflow",
  "category" : "Workflow Context",
  "requires" : "Workflow",
  "description" : "Cancel the workflow with the given id, where the required id is the id of the document representing the workflow instance.",
  "url" : "WorkflowInstance.Cancel",
  "signature" : [ "void", "void" ],
  "params" : [ {
    "name" : "id",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}